Uninstalling a plugin #1531 #1538

ritikbanger · 2022-12-25T08:42:55Z

Document removal of a plugin from container

Make sure you are opening from a topic/feature/bugfix branch (right side) and not your main branch!
Ensure that the pull request title represents the desired changelog entry
Please describe what you did
Link to relevant issues in GitHub or Jira
Link to relevant pull requests, esp. upstream and downstream changes

This PR address the following issue: #1531 which is discussed in SIG December 16th Meeting

cc @dduportal @gounthar

Merry Christmas 🎅

gounthar · 2022-12-25T17:33:45Z

Merry Christmas too, thanks a lot for your contribution. 🙏

README.md

ritikbanger · 2022-12-28T05:37:58Z

Are we ready to merge or is there any more changes @gounthar @dduportal

MarkEWaite

The install-plugins.sh script is no longer a useful script. The plugins.txt file defines the plugins to be installed, not the plugins to be removed (at least as far as I've used it).

README.md

MarkEWaite · 2022-12-28T18:23:57Z

From experiments with the jenkins/jenkins:2.375.1 container, I can remove a plugin from the installation by removing the entry from the plugins.txt file, building a new container image, then stopping the existing container and starting with the new container image.

Dockerfile that I used was:

FROM jenkins/jenkins:2.375.1
COPY --chown=jenkins:jenkins plugins.txt $REF/plugins.txt
RUN jenkins-plugin-cli --plugin-file $REF/plugins.txt

However, that simple use case does not cover the cases where the user is preserving their configuration in a separate data volume. In that case, then I believe that additional steps will be required in order to remove the files from $JENKINS_HOME/plugins/* so that the jenkins.sh script that starts the java -jar jenkins.war process is writing the set of plugins from the $REF directory to the plugins directory without having to remove existing files.

… of creating a new plugin.txt

ritikbanger · 2022-12-29T14:04:40Z

From experiments with the jenkins/jenkins:2.375.1 container, I can remove a plugin from the installation by removing the entry from the plugins.txt file, building a new container image, then stopping the existing container and starting with the new container image.

Dockerfile that I used was:
FROM jenkins/jenkins:2.375.1
COPY --chown=jenkins:jenkins plugins.txt $REF/plugins.txt
RUN jenkins-plugin-cli --plugin-file $REF/plugins.txt
However, that simple use case does not cover the cases where the user is preserving their configuration in a separate data volume. In that case, then I believe that additional steps will be required in order to remove the files from $JENKINS_HOME/plugins/* so that the jenkins.sh script that starts the java -jar jenkins.war process is writing the set of plugins from the $REF directory to the plugins directory without having to remove existing files.

Added a new commit- b0b6bcf

Let me know, if there are any suggestions.

ritikbanger · 2023-01-04T05:00:04Z

Any update on this

MarkEWaite · 2023-01-04T20:49:08Z

Any update on this

Sorry for the delay. It will likely be a few more days before I can review.

gounthar · 2023-01-04T20:55:45Z

Same for me, sorry.

README.md

gounthar

Thanks a lot for your contribution, we do appreciate it. 🙏
Please have a look at my comments and let me know if you agree.
If you don't (which is fine), let's discuss it further.

Once more, thanks.

README.md

ritikbanger · 2023-01-29T15:21:12Z

@MarkEWaite can you help me with the new updates that I need to add or remove from this PR?

daniel-beck

Most of this is general documentation that applies to all Jenkinses. Why is it added to the documentation of the Docker images?

dduportal · 2023-02-08T13:39:53Z

Most of this is general documentation that applies to all Jenkinses. Why is it added to the documentation of the Docker images?

Because it's needed here until a "general documentation with clear examples for Docker" is provided. There are multiple specific elements for Docker image that are required, which does NOT apply to packaged distribution of Jenkins (the fact that plugins should be pre-installed in the image in /usr/share/jenkins/ref but that what Jenkins sees is the data volume in /var/jenkins-home for instance.

ritikbanger · 2023-02-14T18:04:57Z

Hey @dduportal, can you help me with this PR. Its been one month without any update from other maintainers.

MarkEWaite · 2023-02-14T18:08:23Z

Sorry for the delay @ritikbanger . I'll do my best to help with a review within the next 7 days. @dduportal probably won't be able to help due to other priorities that he needs to handle.

dduportal

@ritikbanger thanks for this proposal and sorry for the delay in review but:

It does not seem you did the uninstallation process by yourself. I stronlgy suggest you to try it on a local container, otherwise there is no point in documenting something you have no idea how it works. You should record the video of your attempt as a support for getting help from the SIG platform meeting members
I'm not sure if you are using a ChatGPT tool or anything, but the structure of the text looks really weird, along with inexact assertions and "generic" phrasings. If you did, please avoid this as it only makes you waste your time.
If you did not and wrote all of this PR by yourself, then it means we should go back to the issue and have you follow at least one uninstallation of a plugin in a Jenkins container to draft a structure of "what uninstallation method" should we cover.

As a maintainer and a user, I cannot accept the content as it today: it adds way more confusion that it helps.
I don't mind helping in the direction, but I need you to do it yourself one time first before continuing

README.md

dduportal · 2023-07-01T15:22:38Z

Update: there has been a nice blog post in https://www.jenkins.io/blog/2023/06/20/remove-outdated-plugins-while-using-docker/.

@ritikbanger are you ok to update this PR according to this blog post + take our feedbacks in account?

ritikbanger · 2023-07-02T11:34:57Z

I will be finishing this PR super soon.

ritikbanger · 2023-07-15T17:02:45Z

@dduportal I have updated the PR with your feedback. Please have a look.

ritikbanger · 2023-07-18T15:56:17Z

@gounthar your review will be highly appreciated

gounthar

Thanks a lot for this work. 🤗

README.md

gounthar

Thanks a lot for this work. 🤗

ritikbanger · 2023-08-05T08:16:12Z

@gounthar I think we are ready to merge this.

gounthar · 2023-08-05T10:00:50Z

Thank you very much for your contribution and the latest changes, @ritikbanger.
I don't have the authority to merge your pull request, but I have already approved it.

ritikbanger · 2023-08-12T03:12:32Z

@dduportal

dduportal

It's going in a really good direction! I'm still not in agreement with some major elements.

The main point is that it feels like you want to write a step by step guide: the README is not the place for that. I would prefer having a page in jenkins.io's documentation (which requires asking the documentation SIG group to find the perfect place in the table of content).

I've provided feedback to continue this PR and land it by shrinking steps and being more generic (requiring Docker Compose is not acceptable for instance).

Thanks for this work!

README.md

dduportal · 2024-05-28T07:24:59Z

Hi @ritikbanger , any news? This PR has been opened for quite some time and it would benefit from an update.

ritikbanger · 2024-05-31T05:28:45Z

I would be updating this PR shortly.

gounthar · 2024-05-31T07:42:52Z

Thanks. 🤗

ritikbanger · 2024-07-06T18:04:06Z

@dduportal Please have a look.

dduportal · 2024-07-09T15:05:00Z

@dduportal Please have a look.

Thanks @ritikbanger . I'll check before end of month as I only have low availability for now.

ritikbanger · 2024-08-13T11:04:07Z

@dduportal Please have a look.

Thanks @ritikbanger . I'll check before end of month as I only have low availability for now.

Any update on this

added uninstalling a plugin methods

f7d23be

ritikbanger requested a review from a team as a code owner December 25, 2022 08:42

gounthar reviewed Dec 25, 2022

View reviewed changes